<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>enc2xs -- Perl Encode Module Generator - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/enc2xs">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="enc2xs.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/enc2xs">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/enc2xs">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/enc2xs">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/enc2xs">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/enc2xs">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/enc2xs">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/enc2xs">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/enc2xs">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/enc2xs">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/enc2xs">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/enc2xs">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/enc2xs">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/enc2xs">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/enc2xs">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/enc2xs">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/enc2xs">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/enc2xs">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/enc2xs">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/enc2xs">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/enc2xs">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/enc2xs">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/enc2xs">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/enc2xs">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/enc2xs">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/enc2xs">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/enc2xs">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/enc2xs">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/enc2xs">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/enc2xs">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/enc2xs">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/enc2xs">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/enc2xs">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/enc2xs">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/enc2xs">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/enc2xs">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/enc2xs">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/enc2xs">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/enc2xs">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/enc2xs">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/enc2xs">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/enc2xs">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/enc2xs">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/enc2xs">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/enc2xs">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/enc2xs">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/enc2xs">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/enc2xs">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/enc2xs">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/enc2xs">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/enc2xs">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/enc2xs">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/enc2xs">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/enc2xs">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/enc2xs">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/enc2xs">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/enc2xs">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/enc2xs">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/enc2xs">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/enc2xs">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/enc2xs">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/enc2xs">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/enc2xs">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/enc2xs">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/enc2xs">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/enc2xs">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/enc2xs">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/enc2xs">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/enc2xs">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/enc2xs">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/enc2xs">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/enc2xs">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/enc2xs">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/enc2xs">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/enc2xs">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/enc2xs">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/enc2xs">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/enc2xs">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/enc2xs">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/enc2xs">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/enc2xs">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="enc2xs.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/enc2xs">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/enc2xs">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/enc2xs">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/enc2xs">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/enc2xs">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/enc2xs">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/enc2xs">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/enc2xs">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/enc2xs">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/enc2xs">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/enc2xs">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/enc2xs">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/enc2xs">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/enc2xs">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/enc2xs">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/enc2xs">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/enc2xs">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/enc2xs">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/enc2xs">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/enc2xs">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/enc2xs">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/enc2xs">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/enc2xs">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/enc2xs">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/enc2xs">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/enc2xs">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/enc2xs">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/enc2xs">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/enc2xs">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/enc2xs">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/enc2xs">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/enc2xs">5.35.1</a>
          <a class="dropdown-item active" href="enc2xs.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="enc2xs.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="enc2xs.html">enc2xs</a>
          <div id="more">
            (<a href="enc2xs.txt">source</a>,
            <a href="https://metacpan.org/pod/enc2xs">CPAN</a>)
          </div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#Quick-Guide">Quick Guide</a>
              </li>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#The-Unicode-Character-Map">The Unicode Character Map</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#Coping-with-duplicate-mappings">Coping with duplicate mappings</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#Bookmarks">Bookmarks</a>
              </li>
              <li>
                <a class="text-decoration-none" href="enc2xs.html#SEE-ALSO">SEE ALSO</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="enc2xs.html#NAME">#</a>NAME</h1>

<p>enc2xs -- Perl Encode Module Generator</p>

<h1 id="SYNOPSIS"><a class="permalink" href="enc2xs.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code class="plaintext">enc2xs -[options]
enc2xs -M ModName mapfiles...
enc2xs -C</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="enc2xs.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p><i>enc2xs</i> builds a Perl extension for use by Encode from either Unicode Character Mapping files (.ucm) or Tcl Encoding Files (.enc). Besides being used internally during the build process of the Encode module, you can use <i>enc2xs</i> to add your own encoding to perl. No knowledge of XS is necessary.</p>

<h1 id="Quick-Guide"><a class="permalink" href="enc2xs.html#Quick-Guide">#</a><a id="Quick"></a>Quick Guide</h1>

<p>If you want to know as little about Perl as possible but need to add a new encoding, just read this chapter and forget the rest.</p>

<dl>

<dt id="0."><a class="permalink" href="enc2xs.html#0.">#</a><a id="0"></a><a id="pod0"></a>0.</dt>
<dd>

<p>Have a .ucm file ready. You can get it from somewhere or you can write your own from scratch or you can grab one from the Encode distribution and customize it. For the UCM format, see the next Chapter. In the example below, I&#39;ll call my theoretical encoding myascii, defined in <i>my.ucm</i>. <code>$</code> is a shell prompt.</p>

<pre><code class="plaintext">$ ls -F
my.ucm</code></pre>

</dd>
<dt id="1."><a class="permalink" href="enc2xs.html#1.">#</a><a id="1"></a><a id="pod1"></a>1.</dt>
<dd>

<p>Issue a command as follows;</p>

<pre><code class="plaintext">$ enc2xs -M My my.ucm
generating Makefile.PL
generating My.pm
generating README
generating Changes</code></pre>

<p>Now take a look at your current directory. It should look like this.</p>

<pre><code class="plaintext">$ ls -F
Makefile.PL   My.pm         my.ucm        t/</code></pre>

<p>The following files were created.</p>

<pre><code class="plaintext">Makefile.PL - MakeMaker script
My.pm       - Encode submodule
t/My.t      - test file</code></pre>

<dl>

<dt id="1.1."><a class="permalink" href="enc2xs.html#1.1.">#</a><a id="11"></a><a id="pod1.1"></a>1.1.</dt>
<dd>

<p>If you want *.ucm installed together with the modules, do as follows;</p>

<pre><code class="plaintext">$ mkdir Encode
$ mv *.ucm Encode
$ enc2xs -M My Encode/*ucm</code></pre>

</dd>
</dl>

</dd>
<dt id="2."><a class="permalink" href="enc2xs.html#2.">#</a><a id="2"></a><a id="pod2"></a>2.</dt>
<dd>

<p>Edit the files generated. You don&#39;t have to if you have no time AND no intention to give it to someone else. But it is a good idea to edit the pod and to add more tests.</p>

</dd>
<dt id="3."><a class="permalink" href="enc2xs.html#3.">#</a><a id="3"></a><a id="pod3"></a>3.</dt>
<dd>

<p>Now issue a command all Perl Mongers love:</p>

<pre><code class="plaintext">$ perl Makefile.PL
Writing Makefile for Encode::My</code></pre>

</dd>
<dt id="4."><a class="permalink" href="enc2xs.html#4.">#</a><a id="4"></a><a id="pod4"></a>4.</dt>
<dd>

<p>Now all you have to do is make.</p>

<pre><code class="plaintext">$ make
cp My.pm blib/lib/Encode/My.pm
/usr/local/bin/perl /usr/local/bin/enc2xs -Q -O \
  -o encode_t.c -f encode_t.fnm
Reading myascii (myascii)
Writing compiled form
128 bytes in string tables
384 bytes (75%) saved spotting duplicates
1 bytes (0.775%) saved using substrings
....
chmod 644 blib/arch/auto/Encode/My/My.bs
$</code></pre>

<p>The time it takes varies depending on how fast your machine is and how large your encoding is. Unless you are working on something big like euc-tw, it won&#39;t take too long.</p>

</dd>
<dt id="5."><a class="permalink" href="enc2xs.html#5.">#</a><a id="5"></a><a id="pod5"></a>5.</dt>
<dd>

<p>You can &quot;make install&quot; already but you should test first.</p>

<pre><code>$ make test
PERL_DL_NONLAZY=1 /usr/local/bin/perl -Iblib/arch -Iblib/lib \
  -e &#39;use Test::Harness  qw(&amp;runtests $verbose); \
  $verbose=0; runtests @ARGV;&#39; t/*.t
t/My....ok
All tests successful.
Files=1, Tests=2,  0 wallclock secs
 ( 0.09 cusr + 0.01 csys = 0.09 CPU)</code></pre>

</dd>
<dt id="6."><a class="permalink" href="enc2xs.html#6.">#</a><a id="6"></a><a id="pod6"></a>6.</dt>
<dd>

<p>If you are content with the test result, just &quot;make install&quot;</p>

</dd>
<dt id="7."><a class="permalink" href="enc2xs.html#7.">#</a><a id="7"></a><a id="pod7"></a>7.</dt>
<dd>

<p>If you want to add your encoding to Encode&#39;s demand-loading list (so you don&#39;t have to &quot;use Encode::YourEncoding&quot;), run</p>

<pre><code class="plaintext">enc2xs -C</code></pre>

<p>to update Encode::ConfigLocal, a module that controls local settings. After that, &quot;use Encode;&quot; is enough to load your encodings on demand.</p>

</dd>
</dl>

<h1 id="The-Unicode-Character-Map"><a class="permalink" href="enc2xs.html#The-Unicode-Character-Map">#</a><a id="The"></a>The Unicode Character Map</h1>

<p>Encode uses the Unicode Character Map (UCM) format for source character mappings. This format is used by IBM&#39;s ICU package and was adopted by Nick Ing-Simmons for use with the Encode module. Since UCM is more flexible than Tcl&#39;s Encoding Map and far more user-friendly, this is the recommended format for Encode now.</p>

<p>A UCM file looks like this.</p>

<pre><code class="plaintext">#
# Comments
#
&lt;code_set_name&gt; &quot;US-ascii&quot; # Required
&lt;code_set_alias&gt; &quot;ascii&quot;   # Optional
&lt;mb_cur_min&gt; 1             # Required; usually 1
&lt;mb_cur_max&gt; 1             # Max. # of bytes/char
&lt;subchar&gt; \x3F             # Substitution char
#
CHARMAP
&lt;U0000&gt; \x00 |0 # &lt;control&gt;
&lt;U0001&gt; \x01 |0 # &lt;control&gt;
&lt;U0002&gt; \x02 |0 # &lt;control&gt;
....
&lt;U007C&gt; \x7C |0 # VERTICAL LINE
&lt;U007D&gt; \x7D |0 # RIGHT CURLY BRACKET
&lt;U007E&gt; \x7E |0 # TILDE
&lt;U007F&gt; \x7F |0 # &lt;control&gt;
END CHARMAP</code></pre>

<ul>

<li><p>Anything that follows <code>#</code> is treated as a comment.</p>

</li>
<li><p>The header section continues until a line containing the word CHARMAP. This section has a form of <i>&lt;keyword&gt; value</i>, one pair per line. Strings used as values must be quoted. Barewords are treated as numbers. <i>\xXX</i> represents a byte.</p>

<p>Most of the keywords are self-explanatory. <i>subchar</i> means substitution character, not subcharacter. When you decode a Unicode sequence to this encoding but no matching character is found, the byte sequence defined here will be used. For most cases, the value here is \x3F; in ASCII, this is a question mark.</p>

</li>
<li><p>CHARMAP starts the character map section. Each line has a form as follows:</p>

<pre><code class="plaintext">&lt;UXXXX&gt; \xXX.. |0 # comment
  ^     ^      ^
  |     |      +- Fallback flag
  |     +-------- Encoded byte sequence
  +-------------- Unicode Character ID in hex</code></pre>

<p>The format is roughly the same as a header section except for the fallback flag: | followed by 0..3. The meaning of the possible values is as follows:</p>

<dl>

<dt id="|0"><a class="permalink" href="enc2xs.html#%7C0">#</a><a id="pod-0"></a>|0</dt>
<dd>

<p>Round trip safe. A character decoded to Unicode encodes back to the same byte sequence. Most characters have this flag.</p>

</dd>
<dt id="|1"><a class="permalink" href="enc2xs.html#%7C1">#</a><a id="pod-1"></a>|1</dt>
<dd>

<p>Fallback for unicode -&gt; encoding. When seen, enc2xs adds this character for the encode map only.</p>

</dd>
<dt id="|2"><a class="permalink" href="enc2xs.html#%7C2">#</a><a id="pod-2"></a>|2</dt>
<dd>

<p>Skip sub-char mapping should there be no code point.</p>

</dd>
<dt id="|3"><a class="permalink" href="enc2xs.html#%7C3">#</a><a id="pod-3"></a>|3</dt>
<dd>

<p>Fallback for encoding -&gt; unicode. When seen, enc2xs adds this character for the decode map only.</p>

</dd>
</dl>

</li>
<li><p>And finally, END OF CHARMAP ends the section.</p>

</li>
</ul>

<p>When you are manually creating a UCM file, you should copy ascii.ucm or an existing encoding which is close to yours, rather than write your own from scratch.</p>

<p>When you do so, make sure you leave at least <b>U0000</b> to <b>U0020</b> as is, unless your environment is EBCDIC.</p>

<p><b>CAVEAT</b>: not all features in UCM are implemented. For example, icu:state is not used. Because of that, you need to write a perl module if you want to support algorithmical encodings, notably the ISO-2022 series. Such modules include <a href="https://perldoc.perl.org/5.35.0/Encode::JP::2022_JP">Encode::JP::2022_JP</a>, <a href="./Encode::KR::2022_KR.html">Encode::KR::2022_KR</a>, and <a href="https://perldoc.perl.org/5.35.0/Encode::TW::HZ">Encode::TW::HZ</a>.</p>

<h2 id="Coping-with-duplicate-mappings"><a class="permalink" href="enc2xs.html#Coping-with-duplicate-mappings">#</a><a id="Coping"></a>Coping with duplicate mappings</h2>

<p>When you create a map, you SHOULD make your mappings round-trip safe. That is, <code>encode(&#39;your-encoding&#39;, decode(&#39;your-encoding&#39;, $data)) eq $data</code> stands for all characters that are marked as <code>|0</code>. Here is how to make sure:</p>

<ul>

<li><p>Sort your map in Unicode order.</p>

</li>
<li><p>When you have a duplicate entry, mark either one with &#39;|1&#39; or &#39;|3&#39;.</p>

</li>
<li><p>And make sure the &#39;|1&#39; or &#39;|3&#39; entry FOLLOWS the &#39;|0&#39; entry.</p>

</li>
</ul>

<p>Here is an example from big5-eten.</p>

<pre><code class="plaintext">&lt;U2550&gt; \xF9\xF9 |0
&lt;U2550&gt; \xA2\xA4 |3</code></pre>

<p>Internally Encoding -&gt; Unicode and Unicode -&gt; Encoding Map looks like this;</p>

<pre><code class="plaintext"> E to U               U to E
 --------------------------------------
 \xF9\xF9 =&gt; U2550    U2550 =&gt; \xF9\xF9
 \xA2\xA4 =&gt; U2550</code></pre>

<p>So it is round-trip safe for \xF9\xF9. But if the line above is upside down, here is what happens.</p>

<pre><code class="plaintext">E to U               U to E
--------------------------------------
\xA2\xA4 =&gt; U2550    U2550 =&gt; \xF9\xF9
(\xF9\xF9 =&gt; U2550 is now overwritten!)</code></pre>

<p>The Encode package comes with <i>ucmlint</i>, a crude but sufficient utility to check the integrity of a UCM file. Check under the Encode/bin directory for this.</p>

<p>When in doubt, you can use <i>ucmsort</i>, yet another utility under Encode/bin directory.</p>

<h1 id="Bookmarks"><a class="permalink" href="enc2xs.html#Bookmarks">#</a>Bookmarks</h1>

<ul>

<li><p>ICU Home Page <a href="http://www.icu-project.org/">http://www.icu-project.org/</a></p>

</li>
<li><p>ICU Character Mapping Tables <a href="http://site.icu-project.org/charts/charset">http://site.icu-project.org/charts/charset</a></p>

</li>
<li><p>ICU:Conversion Data <a href="http://www.icu-project.org/userguide/conversion-data.html">http://www.icu-project.org/userguide/conversion-data.html</a></p>

</li>
</ul>

<h1 id="SEE-ALSO"><a class="permalink" href="enc2xs.html#SEE-ALSO">#</a><a id="SEE"></a>SEE ALSO</h1>

<p><a href="Encode.html">Encode</a>, <a href="perlmod.html">perlmod</a>, <a href="perlpod.html">perlpod</a></p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
